Set up documentation using mkdocs #35
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
So my only point why hesitating with this is the consideration of whether we want to have individual docs for all sub-modules, or whether they should all be incorporated into proteus documentation. I cannot exactly remember anymore whether we agreed this was the best solution or not, we discussed this at one of the last meetings. |
|
This can be solved afterwards using subprojects: https://docs.readthedocs.io/en/stable/subprojects.html |
|
Awesome, this sounds good to me then! |
timlichtenberg
approved these changes
Jul 24, 2024
|
If I have time tomorrow I will set this up on readthedocs. |
lsoucasse
pushed a commit
that referenced
this pull request
Sep 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR sets up documentation using mkdocs. You can build the documentation for yourself like this:
Once this is merged I'm happy to set up documentation on readthedocs under https://fwljanus.readthedocs.io
Closes #29